package com.yvon.boot.mybatis.search;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 搜索条件
 * 接受前端搜索条件，进行排序
 *
 * @author : Yvon
 * @since : 2022-12-11
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
public @interface MpSearch {

    /**
     * 别名
     * 对于查询语句中字段所在表的别名
     *
     * @return {@code String }
     */
    String alias() default "";

    /**
     * 字段名
     * 对于查询语句中字段名称
     *
     * @return {@code String[] }
     */
    String[] fieldName() default {};

    /**
     * 操作
     * 对于查询语句中查询条件
     *
     * @return {@code String }
     */
    Operator operate() default Operator.eq;

    /**
     * 值
     * 对于查询语句中查询条件的值
     *
     * @return {@code String }
     */
    String[] value() default {};

    /**
     * 自动排序，该属性是实现默认字段排序
     *
     * @return {@link MpOrder.Order}
     */
    MpOrder.Order autoOrder() default MpOrder.Order.none;

    /**
     * 忽略
     *
     * @return boolean
     */
    boolean ignore() default false;


    public static enum Operator {
        eq,
        ne,
        gt,
        ge,
        lt,
        le,
        betweenStart,
        betweenEnd,

        notBetweenStart,
        notBetweenEnd,
        like,
        notLike,
        orLike,
        likeLeft,
        likeRight,
        in,
        notIn,
        isNull,
        isNotNull;

        private Operator() {
        }
    }

}
